Skip to content

docs: improve docstrings of storages - #465

Merged
vdusek merged 3 commits into
masterfrom
update-storage-docs
Aug 27, 2024
Merged

vdusek merged 3 commits into
masterfrom
update-storage-docs

Conversation

@vdusek

@vdusek vdusek commented Aug 27, 2024 •

Copy link
Copy Markdown
Collaborator

Description

  • Improve docstrings of storage classes.
  • I also changed the list of main classes to reflect at least "somehow" the current public interface.

Issues

Testing

  • Website was rendered locally.

Checklist

  • CI passed

@vdusek
vdusek requested a review from janbuchar August 27, 2024 08:40
@vdusek vdusek self-assigned this Aug 27, 2024
@github-actions github-actions Bot added this to the 97th sprint - Tooling team milestone Aug 27, 2024
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Aug 27, 2024

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@janbuchar janbuchar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question, LGTM otherwise

Comment thread src/crawlee/storages/_dataset.py Resolved
Comment thread website/transformDocs.js Resolved

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

None of the pull request and linked issue has estimate

@janbuchar

Copy link
Copy Markdown
Collaborator

Could you please link to the guide from https://github.com/apify/crawlee-python/releases/tag/v0.3.0 once this PR is out?

@vdusek
vdusek merged commit 8dd28fc into master Aug 27, 2024
@vdusek
vdusek deleted the update-storage-docs branch August 27, 2024 11:15
@vdusek vdusek mentioned this pull request Oct 2, 2024
29 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants